<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>cat snapshots API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'cat-snapshots.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-snapshots.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-snapshots.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/cat-snapshots.html" rel="nofollow" target="_blank">../en/cat-snapshots.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cat.html">cat APIs</a></span>
»
<span class="breadcrumb-node">cat snapshots API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cat-segments.html">« cat segments API</a>
</span>
<span class="next">
<a href="cat-tasks.html">cat task management API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cat-snapshots"></a>cat snapshots API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/snapshots.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns information about the <a class="xref" href="modules-snapshots.html" title="Snapshot module">snapshots</a> stored in one or
more repositories. A snapshot is a backup of an index or running Elasticsearch cluster.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-snapshots-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/snapshots.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_cat/snapshots/&lt;repository&gt;</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-snapshots-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/snapshots.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;repository&gt;</code>
</span>
</dt>
<dd>
<p>(Required, string) Snapshot repository used to limit the request.</p>
<p>If the repository fails during the request, Elasticsearch returns an error.</p>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-snapshots-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/snapshots.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">format</code>
</span>
</dt>
<dd>
(Optional, string) Short version of the
<a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html" class="ulink" target="_top">HTTP accept header</a>.
Valid values include JSON, YAML, etc.
</dd>
<dt>
<span class="term">
<code class="literal">h</code>
</span>
</dt>
<dd>
<p>
(Optional, string) Comma-separated list of column names to display.
</p>
<p>If you do not specify which columns to include, the API returns the default
columns in the order listed below. If you explicitly specify one or more
columns, it only returns the specified columns.</p>
<p>Valid columns are:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">id</code>, <code class="literal">snapshot</code>
</span>
</dt>
<dd>
(Default) ID of the snapshot, such as <code class="literal">snap1</code>.
</dd>
<dt>
<span class="term">
<code class="literal">repository</code>, <code class="literal">re</code>, <code class="literal">repo</code>
</span>
</dt>
<dd>
(Default) Name of the repository, such as <code class="literal">repo1</code>.
</dd>
<dt>
<span class="term">
<code class="literal">status</code>, <code class="literal">s</code>
</span>
</dt>
<dd>
<p>
(Default) State of the snapshot process. Returned values are:
</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">FAILED</code>: The snapshot process failed.
</li>
<li class="listitem">
<code class="literal">INCOMPATIBLE</code>: The snapshot process is incompatible with the current cluster
version.
</li>
<li class="listitem">
<code class="literal">IN_PROGRESS</code>: The snapshot process started but has not completed.
</li>
<li class="listitem">
<code class="literal">PARTIAL</code>: The snapshot process completed with a partial success.
</li>
<li class="listitem">
<code class="literal">SUCCESS</code>: The snapshot process completed with a full success.
</li>
</ul>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">start_epoch</code>, <code class="literal">ste</code>, <code class="literal">startEpoch</code>
</span>
</dt>
<dd>
(Default) <a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix <code class="literal">epoch</code> time</a> at which
the snapshot process started.
</dd>
<dt>
<span class="term">
<code class="literal">start_time</code>, <code class="literal">sti</code>, <code class="literal">startTime</code>
</span>
</dt>
<dd>
(Default) <code class="literal">HH:MM:SS</code> time at which the snapshot process started.
</dd>
<dt>
<span class="term">
<code class="literal">end_epoch</code>, <code class="literal">ete</code>, <code class="literal">endEpoch</code>
</span>
</dt>
<dd>
(Default) <a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix <code class="literal">epoch</code> time</a> at which
the snapshot process ended.
</dd>
<dt>
<span class="term">
<code class="literal">end_time</code>, <code class="literal">eti</code>, <code class="literal">endTime</code>
</span>
</dt>
<dd>
(Default) <code class="literal">HH:MM:SS</code> time at which the snapshot process ended.
</dd>
<dt>
<span class="term">
<code class="literal">duration</code>, <code class="literal">dur</code>
</span>
</dt>
<dd>
(Default) Time it took the snapshot process to complete in <a class="xref" href="common-options.html#time-units" title="Time units">time
units</a>.
</dd>
<dt>
<span class="term">
<code class="literal">indices</code>, <code class="literal">i</code>
</span>
</dt>
<dd>
(Default) Number of indices in the snapshot.
</dd>
<dt>
<span class="term">
<code class="literal">successful_shards</code>, <code class="literal">ss</code>
</span>
</dt>
<dd>
(Default) Number of successful shards in the snapshot.
</dd>
<dt>
<span class="term">
<code class="literal">failed_shards</code>, <code class="literal">fs</code>
</span>
</dt>
<dd>
(Default) Number of failed shards in the snapshot.
</dd>
<dt>
<span class="term">
<code class="literal">total_shards</code>, <code class="literal">ts</code>
</span>
</dt>
<dd>
(Default) Total number of shards in the snapshot.
</dd>
<dt>
<span class="term">
<code class="literal">reason, `r</code>
</span>
</dt>
<dd>
Reason for any snapshot failures.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">help</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes help information. Defaults
to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">ignore_unavailable</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response does not include information from
unavailable snapshots. Defaults to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">master_timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
<dt>
<span class="term">
<code class="literal">s</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list of column names or column aliases used
to sort the response.
</dd>
<dt>
<span class="term">
<code class="literal">time</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>)
Unit used to display time values.
</dd>
<dt>
<span class="term">
<code class="literal">v</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes column headings.
Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-snapshots-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/snapshots.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cat/snapshots/repo1?v&amp;s=id</pre>
</div>
<div class="console_widget" data-snippet="snippets/1378.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">id     status start_epoch start_time end_epoch  end_time duration indices successful_shards failed_shards total_shards
snap1  FAILED 1445616705  18:11:45   1445616978 18:16:18     4.6m       1                 4             1            5
snap2 SUCCESS 1445634298  23:04:58   1445634672 23:11:12     6.2m       2                10             0           10</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cat-segments.html">« cat segments API</a>
</span>
<span class="next">
<a href="cat-tasks.html">cat task management API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>